USB UART 6 Click Driver

API for configuring and manipulating USB UART 6 Click driver. More...

Topics
	USB UART 6 Device Settings
	Settings for registers of USB UART 6 Click driver.
	USB UART 6 MikroBUS Map
	MikroBUS pin mapping of USB UART 6 Click driver.

Functions
void	usbuart6_cfg_setup (usbuart6_cfg_t *cfg)
	USB UART 6 configuration object setup function.
err_t	usbuart6_init (usbuart6_t *ctx, usbuart6_cfg_t *cfg)
	USB UART 6 initialization function.
err_t	usbuart6_generic_write (usbuart6_t *ctx, uint8_t *data_in, uint16_t len)
	USB UART 6 data writing function.
err_t	usbuart6_generic_read (usbuart6_t *ctx, uint8_t *data_out, uint16_t len)
	USB UART 6 data reading function.
void	usbuart6_enable_device (usbuart6_t *ctx)
	USB UART 6 enable device function.
void	usbuart6_disable_device (usbuart6_t *ctx)
	USB UART 6 disable device function.
void	usbuart6_set_cts_pin (usbuart6_t *ctx, uint8_t state)
	USB UART 6 set CTS pin function.
uint8_t	usbuart6_get_rts_pin (usbuart6_t *ctx)
	USB UART 6 get RTS pin function.

Detailed Description

API for configuring and manipulating USB UART 6 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

usbuart6_cfg_setup()

void usbuart6_cfg_setup

(

usbuart6_cfg_t *

cfg

)

USB UART 6 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See usbuart6_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

usbuart6_disable_device()

void usbuart6_disable_device

(

usbuart6_t *

ctx

)

USB UART 6 disable device function.

This function disables the device by setting the EN pin to low logic state.

Parameters

[in]

ctx

: Click context object. See usbuart6_t object definition for detailed explanation.

Returns

None.

Note

None.

usbuart6_enable_device()

void usbuart6_enable_device

(

usbuart6_t *

ctx

)

USB UART 6 enable device function.

This function enables the device by setting the EN pin to high logic state.

Parameters

[in]

ctx

: Click context object. See usbuart6_t object definition for detailed explanation.

Returns

None.

Note

None.

usbuart6_generic_read()

err_t usbuart6_generic_read	(	usbuart6_t *	ctx,
		uint8_t *	data_out,
		uint16_t	len )

USB UART 6 data reading function.

This function reads a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See usbuart6_t object definition for detailed explanation.
[out]	data_out	: Output read data.
[in]	len	: Number of bytes to be read.

Returns

• >0 - Number of data bytes read,
• <=0 - Error/Empty Ring buffer. See #err_t definition for detailed explanation.

Note

None.

usbuart6_generic_write()

err_t usbuart6_generic_write	(	usbuart6_t *	ctx,
		uint8_t *	data_in,
		uint16_t	len )

USB UART 6 data writing function.

This function writes a desired number of data bytes by using UART serial interface.

Parameters

[in]	ctx	: Click context object. See usbuart6_t object definition for detailed explanation.
[in]	data_in	: Data buffer for sending.
[in]	len	: Number of bytes for sending.

Returns

• >=0 - Success,
• <0 - Error. See #err_t definition for detailed explanation.

Note

None.

usbuart6_get_rts_pin()

uint8_t usbuart6_get_rts_pin

(

usbuart6_t *

ctx

)

USB UART 6 get RTS pin function.

This function returns the RTS pin logic state.

Parameters

[in]

ctx

: Click context object. See usbuart6_t object definition for detailed explanation.

Returns

Pin logic state.

Note

None.

usbuart6_init()

err_t usbuart6_init	(	usbuart6_t *	ctx,
		usbuart6_cfg_t *	cfg )

USB UART 6 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See usbuart6_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See usbuart6_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

usbuart6_set_cts_pin()

void usbuart6_set_cts_pin	(	usbuart6_t *	ctx,
		uint8_t	state )

USB UART 6 set CTS pin function.

This function sets the CTS pin logic state.

Parameters

[in]	ctx	: Click context object. See usbuart6_t object definition for detailed explanation.
[in]	state	: Pin logic state.

Returns

None.

Note

None.